docs(readme): add screenshots to all READMEs#3
Merged
Conversation
Add a Screenshots section showing the Mission Control overlay and the General / Keyboard Shortcuts settings panes, so visitors can see what CloseUp does before installing. Each shot ships light and dark variants selected via `<picture>` + `prefers-color-scheme`, so the images track the reader's GitHub theme. The overlay shot is language-neutral (traffic lights only); the settings shots use the localized zh-CN captures in the Chinese READMEs and the English captures everywhere else. Translated READMEs live one directory deeper, so they reference the images with `../images/` rather than the root's `docs/images/`. Signed-off-by: Kevin Cui <bh@bugs.cc>
Summary by CodeRabbit
WalkthroughThis pull request adds a new "Screenshots" documentation section to the main README.md and to all eight localized README files (German, Spanish, French, Japanese, Portuguese-BR, Russian, Simplified Chinese, Traditional Chinese). Each section contains centered image markup embedding three screenshots—an overlay preview over the Mission Control view, a General settings screen, and a Keyboard shortcuts screen—each with light/dark variants selected via Changes
Related PRs: None identified. Suggested labels: documentation Suggested reviewers: None identified. Poem 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches✨ Simplify code
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/README/README.zh-TW.md`:
- Around line 16-25: The Traditional Chinese README still references English
screenshot assets in the localized image block, so update the picture entries in
README.zh-TW to use the corresponding localized settings screenshots instead of
the settings-general-en-* and settings-shortcuts-en-* files. Keep the same
markup structure, but swap the src and srcset values in the README image section
so they match the Chinese localization pattern used elsewhere in the docs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 58ac9e43-ec7c-4b26-95d3-ac54650e7b6d
⛔ Files ignored due to path filters (10)
docs/images/overlay-dark.pngis excluded by!**/*.pngdocs/images/overlay-light.pngis excluded by!**/*.pngdocs/images/settings-general-en-dark.pngis excluded by!**/*.pngdocs/images/settings-general-en-light.pngis excluded by!**/*.pngdocs/images/settings-general-zh-CN-dark.pngis excluded by!**/*.pngdocs/images/settings-general-zh-CN-light.pngis excluded by!**/*.pngdocs/images/settings-shortcuts-en-dark.pngis excluded by!**/*.pngdocs/images/settings-shortcuts-en-light.pngis excluded by!**/*.pngdocs/images/settings-shortcuts-zh-CN-dark.pngis excluded by!**/*.pngdocs/images/settings-shortcuts-zh-CN-light.pngis excluded by!**/*.png
📒 Files selected for processing (9)
README.mddocs/README/README.de.mddocs/README/README.es.mddocs/README/README.fr.mddocs/README/README.ja.mddocs/README/README.pt-BR.mddocs/README/README.ru.mddocs/README/README.zh-CN.mddocs/README/README.zh-TW.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a Screenshots section to the root README and all nine translated READMEs so visitors can see the Mission Control overlay and the Settings panes before installing.
Each screenshot ships light and dark variants selected via
<picture>+prefers-color-scheme, so they track the reader's GitHub theme. The overlay shot is language-neutral (traffic lights only) and shared everywhere; the General and Keyboard Shortcuts settings shots use the localized zh-CN captures in the Chinese READMEs and the English captures elsewhere. Because the translated READMEs live one directory deeper underdocs/README/, they reference the images with../images/while the root usesdocs/images/.